home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / disk / misc / FileStorage13.lha / FileStorage / FileStorage.doc next >
Encoding:
Text File  |  1993-01-13  |  13.9 KB  |  365 lines

  1.  
  2.  
  3.                              File storage v1.3
  4.  
  5.                               by Joep Grooten
  6.  
  7.                        (c) Digital Intelligence 1992
  8.  
  9.  
  10.  
  11. What is file storage ?
  12.  
  13. File  Storage  is  a  file  librarian,  a database for files.  The database
  14. exists  of  a  number of index files (index files contain information about
  15. files  in the collection) and disks where File Storage puts your collection
  16. of files.  You can add files to the collection and File Storage will put it
  17. on  a  disk  for  you.   File  Storage 'remembers' how many free bytes each
  18. storage disk has and tries to fill the disks to the maximum.  For each file
  19. you  can  add  a 320 characters long description and set 16 different (user
  20. definable)  filetypes.   Searching  / adding / deleting / changing it's all
  21. there !
  22.  
  23.  
  24. INDEX
  25.  
  26. 1.0  Installation
  27. 1.1  Explanation of main screen gadgets
  28. 1.2  Preferences
  29. 1.3  Print menu
  30. 1.4  About
  31. 1.5  Quit
  32. 1.6  Total free bytes
  33. 1.7  Total Info
  34. 1.8  Date search
  35. 1.9  No description search
  36. 2.0  Filetype search
  37. 2.1  Check disks
  38. 2.2  Copy/paste description
  39. 2.3  Distribution
  40.  
  41.  
  42. 1.0  Installation
  43. In   the   package   of   filestorage   you'll   find   'FileStorage'   and
  44. 'FileStorage.small'.   'FileStorage.small'  is  a  limited  version  of the
  45. normal  File  Storage.   It's limited in it's use (only 5 disks).  The file
  46. 'FileStorage'  is  ment  for  registered users.  If you have registered for
  47. FileStorage  use the program 'Unlock' to unlock 'FileStorage'.  Just double
  48. click  it's  icon  or type 'Unlock' in the CLI.  Unlock will prompt you for
  49. your name and key (the key you received when you registered) If you type in
  50. your  name  and key correctly (key must be in UPPERCASE !) Unlock will make
  51. the program FileStorage usable.
  52.  
  53. When you startup FileStorage for the first time you'll see a requester that
  54. will tell you the preferences can't be found.  Just click 'Okay' and you'll
  55. enter  the  Preferences menu.  Change the preferences to your own needs and
  56. click 'Save Prefs'
  57.  
  58. Data directory : Disk/Directory where to keep the datafiles for FileStorage
  59.  
  60. Disk Name      : Name to use for floppy disks to store your files
  61.                  example : 'Storage-#'  (FileStorage puts numbers behind it
  62.                  starting at zero)
  63.  
  64. Safety Bytes   : Number of bytes to keep free on each disk. Just to be sure
  65.                  it fits.
  66.  
  67. Printer output : Name of the device to send printer output to
  68.  
  69. Prt prefix     : This string will be printed BEFORE the filename
  70.  
  71. Prt suffix     : This string will  be printed  AFTER  the filename (You can
  72.                  use  Prt  prefix  and  postfix  to  print  filenames in  a
  73.                  different font for example)
  74. Edit file types: Will be explained later in this documentation.
  75.  
  76. Save changes   : Will be explained later in this documentation.
  77.    immediately
  78.  
  79. After  you  clicked  'Save  Prefs'  a requester will appear 'Can't open...'
  80. Click   'Yes'   and  the  index  file  for  filestorage  will  be  created.
  81. FileStorage now is ready to use.
  82.  
  83.  
  84. 1.1  EXPLANATION OF MAIN SCREEN GADGETS
  85.  
  86. * [Addfile(s)] Adds one or more files to your collection.  For each program
  87. it  searches  for  a  disk  where  it  will fit.  Added files appear in the
  88. listview  gadget at the bottom of the screen.  To select more than one file
  89. keep shift pressed and click on files you want to add.
  90.  
  91. *  [Add  file(s) no copy] Adds a file to the collection without copying it.
  92. This  is  handy  when  a file is already on a storage disk, but you haven't
  93. cataloged  it  yet.   Insert  the disk containing the file in a disk-drive.
  94. You'll  have to know the number of the disk the file is on.  Make that disk
  95. the current disk (see disk info box).  You can make a disk the current disk
  96. by  jumping to the disk or use the disk up/dn gadgets.  After you jumped to
  97. the  right  disk, you can add the file (by pressing the add files (no copy)
  98. gadget)  The  file  info will be added to the collection data, but the file
  99. will not be copied again.
  100.  
  101. *  [Copy  current  file]  Allows  you  to  copy the current file to another
  102. (hard)disk.
  103.  
  104. *  [Search for text] Searches the entire collection for a piece of text (it
  105. searches  both  filenames  and descriptions) Usage of wildcards is allowed.
  106. When  the  search  string  is  found, the entry will appear in the listview
  107. gadget. Search is NOT case sensitive.
  108.  
  109. * [>] Shows the next entry of the current disk
  110.  
  111. * [<] Shows the previous entry of the current disk
  112.  
  113. * [>>] Make next disk the current disk
  114.  
  115. * [<<] Make previous disk the current disk
  116.  
  117. * [Jump to disk] Asks for a disk nr to make the current disk
  118.  
  119. *  [Disk  locked]  When  you  click  this gadget, a checkflag appears.  The
  120. current  disk is now locked.  No more files can be added to or deleted from
  121. this  disk.   This  option  is useful if you have disks that are so old you
  122. don't  want  to write to them again.  Press the Disk locked gadget again to
  123. unlock a disk.
  124.  
  125. *  [Create new disk file] If you press this gadget, a requester will appear
  126. with  the message :  'Next disk will be 'DISKNAME xx' Do you want to create
  127. it  ?'  If  you  press  the  YES  gadget, an index file for disk xx of your
  128. collection  will  be  created.  You'll have to format the disk yourself and
  129. use  the  diskname  you  saw in the requester.  After you clicked YES, File
  130. Storage asks you to insert this disk to read the free bytes.  If everything
  131. went okay, this disk is ready to be used by File Storage.
  132.  
  133. * [Clear scroll list] Clears all the names in the listview gadget (NO FILES
  134. ARE DELETED BY THIS ACTION !!!)
  135.  
  136. * [Delete file] Deletes the current visible file.
  137.  
  138. * [Type] Set filetype (multiple selections are possible)
  139.  
  140. Below  [UP]  and  [DN] is an information line that displays some info about
  141. the current file.  Example :
  142.  
  143. 16-oct-92 [3][002] LhA_e138.run (13865)
  144.  
  145. The  first item is the date the file was added to the collection.  Next [3]
  146. is  the  disk  the file is on.  The next nr [002] is the file nr.  Then the
  147. filename is displayed, and between brackets is the file length.  Under this
  148. line  are  4  gadgets  containing  the  file  description.   You can change
  149. descriptions  at  all  times.   When  you  go  to  another disk or quit the
  150. program, file descriptions are automatically saved.
  151.  
  152. You can click on the data to change it.
  153.  
  154. *  If  you  press  the  space  bar,  the  current file will be added in the
  155. listview gadget.
  156.  
  157.  
  158.  
  159. 1.2 PREFERENCES
  160. To  go  to  the  preferences  menu  use the pull down menu or the short-cut
  161. Amiga-P.
  162.  
  163. Data directory : Directory where to keep the datafiles for FileStorage
  164.  
  165. Disk Name      : Name  to  use for  floppy  disks  to  store  your programs
  166.                  example : 'Storage-#' (FileStorage puts numbers behind it,
  167.                  starting at 0)
  168.  
  169. Safety Bytes   : Number of bytes to keep free on each disk.
  170.  
  171. Printer output : Name of the device to send printer output to
  172.  
  173. Prt prefix     : This string will be printed BEFORE the filename
  174.  
  175. Prt suffix     : This string  will  be printed AFTER  the filename (You can
  176.                  use  Prt  prefix  and  postfix  to  print  filenames  in a
  177.                  different font for example)
  178.  
  179. Edit file      : In edit file types you can change the names of the 16 file
  180.          types   types.   When  you  add  a file, set the filetype for that
  181.                  file.  Later you can search for certain types of files.
  182.  
  183. Save changes   : If  you  turn this option on, all data will be saved after
  184.    immediately   every  change you make.  If you turn this option off, data
  185.                  will  be  saved  when you jump to another disk or when you
  186.                  quit the program.
  187.  
  188.  
  189. [Save prefs] Saves the preferences and uses it
  190. [Use prefs]  Uses the preferences (doesn't save)
  191. [Cancel]     Quit to main menu and don't use the new changes
  192.  
  193.  
  194. 1.3 PRINT MENU
  195. To go to the print menu use the pull down menu or the short-cut Amiga-M.
  196.  
  197. [Print current disk]  Prints all the files on the current active disk
  198. [Print items in list] Prints all the items in the listview gadget
  199. [Print current item]  Prints the current visible file
  200. [Print all disks]     Prints all files of all disks
  201. [Cancel]              Quit to main menu
  202.  
  203.  
  204. 1.4 ABOUT (pull down menu)
  205. This gives you some information about the program.
  206.  
  207.  
  208. 1.5 QUIT (pull down menu)
  209. Quits the program. Everything will be saved.
  210.  
  211.  
  212. 1.6 TOTAL FREE BYTES (pull down menu)
  213. Shows the total number of free bytes of all unlocked disks.
  214.  
  215.  
  216. 1.7 TOTAL INFO (pull down menu)
  217. Shows nr of disks used, nr of files, nr of bytes used, nr of bytes free (of
  218. unlocked disks) nr of free bytes (all disks).
  219.  
  220.  
  221. 1.8 DATE SEARCH (pull down menu)
  222. Date  search  allows  you  to  search  for files with a certain date, files
  223. before / after a date.  Search files from ..  to ..  and list all the files
  224. (old  to  new  /  new  to  old)  Found  files  will  be  displayed  in  the
  225. listviewgadget of the main screen.
  226.  
  227.  
  228. 1.9  NO DESCRIPTION SEARCH (pull down menu)
  229. Search  for files without a description.  Handy for tracking down files you
  230. forgot to give a description.
  231.  
  232.  
  233. 2.0 FILE TYPE SEARCH (pull down menu)
  234. File  type  search allows 2 different ways of searching.  1) 'File may have
  235. extra types'.  If a file has more types than you searched for it will still
  236. appear  in the listview gadget.  2) 'File may not have extra types'.  Found
  237. files must match the type you searched for.
  238.  
  239.  
  240. 2.1 CHECK DISKS (pull down menu)
  241. Check disks checks if all files are still present and looks for uncataloged
  242. files.   'Check  one disk' checks just one disk of your collection.  'Check
  243. all  disks'  (what  else)  checks all disks of your collection.  'See error
  244. list' shows the last error list generated by check one/all disk(s).
  245.  
  246.  
  247. 2.2 COPY/PASTE DESCRIPTION (pull down menu)
  248. Copy description copies the description and filetype of the current file to
  249. a  buffer.   Paste  description  puts back the buffer into the current file
  250. description.   You  can  use  this when you are adding a newer version of a
  251. file  to  the  library.   It  saves  you  the  work  of  typing  a new file
  252. description.
  253.  
  254.  
  255. 2.3 Distribution
  256. """"""""""""""""
  257.  
  258. File  Storage  may be freely distributed as long as the package is still in
  259. it's  original  form.   All files included in the package are copyright (c)
  260. Digital  Intelligence.   You may use the small version as long as you like.
  261. If  you  want to use the normal version (up to 1000 disks !) you'll have to
  262. register by sending 20 Dutch guilders (approx.  12 US dollars) to :
  263.  
  264.  
  265.   Digital Intelligence
  266.   J.J. Allanstraat 222
  267.   1551RR Westzaan
  268.   Holland
  269.  
  270.  
  271. Please  send  Eurocheques  (HFL) or Dutch guilders (preffered) ONLY.  Other
  272. forms  of  payment  can't  be  accepted.   After you have registered you'll
  273. receive  a  disk containing the latest version of File Storage plus the key
  274. to  unlock  future  versions  of  File Storage.  After this you must obtain
  275. future  versions  of File Storage yourself (for example by downloading them
  276. from BBS's)
  277.  
  278.  
  279.  
  280. THANKS : (random order)
  281. """""""""""""""""""""""
  282.  
  283. Ewout Kramer, Stephan Möding, Paul van der Valk, Stanley Merkx.
  284.  
  285.  
  286.  
  287. HISTORY
  288. """""""
  289.  
  290. 29-sep-92 : First 'release' (to Ewout Kramer only :-)
  291.  
  292. 30-sep-92 : Lot's of complaints from Ewout :
  293.             * Data always to DH1:
  294.             * Disk names couldn't be changed
  295.             * Couldn't create new datafiles for disks
  296.  
  297.             Added  preferences  menu  +  print  menu.
  298.  
  299. 31-sep-92 : Multiple   file  select  implemented  (added  files  appear  in
  300.             listview gadget)
  301.  
  302. 01-oct-92 : Searching for a string that is found in all files over 13 disks
  303.             takes 11 secs.  Trying to improve that.
  304.  
  305. 01-oct-92 : Searching  is  now 3 times faster.  Searching for a string that
  306.             is found in ALL files over 13 disks takes 4 seconds.  Searching
  307.             for a string that is only found once or twice takes less then a
  308.             second.
  309.  
  310. 13-oct-92 : Jump to disk no longer jumps to unused disks.  After create new
  311.             diskfile automatic jump to new disk.  AddFile first checks if a
  312.             file  is  already  on  disk.   Added pattern matching to search
  313.             function.
  314.  
  315. 14-oct-92 : Free  bytes  display  now displays all free bytes (and not free
  316.             bytes minus safetybytes)
  317.  
  318. 15-oct-92 : Added menu 'Total free bytes' and 'Total info'
  319.  
  320. 16-oct-92 : Added  file  dates (I had to change the data structure, so this
  321.             will be version v1.1) Turned 'Information line ' into a gadget.
  322.             Now  you  can  change  the  file information (date/name/re-read
  323.             size)
  324.  
  325. 17-oct-92 : No  more  'free disk bytes :  -1' when free disk bytes can't be
  326.             read, old value is used.
  327.  
  328. 22-oct-92 : Finished  the  'print  items in list' in print menu (completely
  329.             forgot  to  finish  it ;-) Changed the printer menu.  Now files
  330.             can be 'printed' to a file too !  Added date search menu.  Date
  331.             of  file is now also displayed in listview gadget.  Added Check
  332.             disks  menu.   Check  disks  checks if files are missing or not
  333.             cataloged.
  334.  
  335. 27-oct-92 : Added  'No  description  search'.   It allows you to search for
  336.             files  without  a  description.  Added file types.  You can now
  337.             define  16 different filetypes.  Again I had to change the data
  338.             structure.   I  added  one  word  (16  bits)  so I could use 16
  339.             filetypes, this version will be v1.2
  340.  
  341. 28-oct-92 : Added 'Filetype Search'
  342.  
  343. 11-nov-92 : Removed 'bug' When cancel after addfiles, FileStorage asked for
  344.             disk 0
  345.  
  346. 19-nov-92 : Release of FileStorage v1.2
  347.  
  348. 24-nov-92 : Changed  Read()  and  Write() functions into FRead() and FWrite
  349.             for speed.
  350.  
  351. 05-jan-93 : Made  userinterface a lot friendlier (suggested by Paul van der
  352.             Valk).   No  longer  a  messy  listview  (suggested  by  Stefan
  353.             Möding). Added copy back function (suggested by Stefan Möding).
  354.             Added  save  changes  immediately  option  (suggested  by Ewout
  355.             Kramer).
  356.  
  357. 06-jan-93 : Delete  file  requester  now displays filename before deletion.
  358.             Added  a  progress  bar  while copying files.  Added copy/paste
  359.             description.
  360.  
  361. 13-jan-93 : Search  function  handles  deleted  files  now  correct  (error
  362.             reported by Ewout Kramer).
  363.  
  364. 13-jan-93 : Release of FileStorage v1.3
  365.